org.eclipse.vtp.framework.engine.support
Class AbstractLogger

java.lang.Object
  extended by org.eclipse.vtp.framework.engine.support.AbstractReporter
      extended by org.eclipse.vtp.framework.engine.support.AbstractLogger
All Implemented Interfaces:
ILogger, IReporter
Direct Known Subclasses:
AbstractContext

public abstract class AbstractLogger
extends AbstractReporter
implements ILogger

A support implementation of the ILogger interface.

Author:
Lonnie Pryor

Field Summary
 
Fields inherited from interface org.eclipse.vtp.framework.core.IReporter
SEVERITY_DEBUG, SEVERITY_ERROR, SEVERITY_INFO, SEVERITY_WARN
 
Constructor Summary
protected AbstractLogger()
          Creates a new AbstractLogger.
 
Method Summary
 void debug(java.lang.String message)
          Creates and publishes a debug log entry with the specified attributes.
 void debug(java.lang.String[] categories, java.lang.String message)
          Creates and publishes a debug log entry with the specified attributes.
 void debug(java.lang.String[] categories, java.lang.String message, java.util.Dictionary properties)
          Creates and publishes a debug log entry with the specified attributes.
 void debug(java.lang.String message, java.util.Dictionary properties)
          Creates and publishes a debug log entry with the specified attributes.
protected  void doLog(int severity, java.lang.String[] categories, java.lang.String message, java.util.Dictionary properties)
          Implementation of log entry creation and publication.
 void error(java.lang.String message)
          Creates and publishes an error log entry with the specified attributes.
 void error(java.lang.String[] categories, java.lang.String message)
          Creates and publishes an error log entry with the specified attributes.
 void error(java.lang.String[] categories, java.lang.String message, java.util.Dictionary properties)
          Creates and publishes an error log entry with the specified attributes.
 void error(java.lang.String message, java.util.Dictionary properties)
          Creates and publishes an error log entry with the specified attributes.
 void info(java.lang.String message)
          Creates and publishes an informational log entry with the specified attributes.
 void info(java.lang.String[] categories, java.lang.String message)
          Creates and publishes an informational log entry with the specified attributes.
 void info(java.lang.String[] categories, java.lang.String message, java.util.Dictionary properties)
          Creates and publishes an informational log entry with the specified attributes.
 void info(java.lang.String message, java.util.Dictionary properties)
          Creates and publishes an informational log entry with the specified attributes.
 boolean isDebugEnabled()
          Returns true if the debug severity level is enabled.
 boolean isErrorEnabled()
          Returns true if the error severity level is enabled.
 boolean isInfoEnabled()
          Returns true if the informational severity level is enabled.
 boolean isWarnEnabled()
          Returns true if the warning severity level is enabled.
 void log(int severity, java.lang.String message)
          Creates and publishes a log entry with the specified attributes.
 void log(int severity, java.lang.String[] categories, java.lang.String message)
          Creates and publishes a log entry with the specified attributes.
 void log(int severity, java.lang.String[] categories, java.lang.String message, java.util.Dictionary properties)
          Creates and publishes a log entry with the specified attributes.
 void log(int severity, java.lang.String message, java.util.Dictionary properties)
          Creates and publishes a log entry with the specified attributes.
 void warn(java.lang.String message)
          Creates and publishes a warning log entry with the specified attributes.
 void warn(java.lang.String[] categories, java.lang.String message)
          Creates and publishes a warning log entry with the specified attributes.
 void warn(java.lang.String[] categories, java.lang.String message, java.util.Dictionary properties)
          Creates and publishes a warning log entry with the specified attributes.
 void warn(java.lang.String message, java.util.Dictionary properties)
          Creates and publishes a warning log entry with the specified attributes.
 
Methods inherited from class org.eclipse.vtp.framework.engine.support.AbstractReporter
doReport, report, report, report, report
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.vtp.framework.core.IReporter
isSeverityEnabled, report, report, report, report
 

Constructor Detail

AbstractLogger

protected AbstractLogger()
Creates a new AbstractLogger.

Method Detail

doLog

protected void doLog(int severity,
                     java.lang.String[] categories,
                     java.lang.String message,
                     java.util.Dictionary properties)
Implementation of log entry creation and publication.

Parameters:
severity - The severity of the log.
categories - The categories the log entry pertains to or null if no catagories are related.
message - The message associated with the log entry or null to not include a message.
properties - The properties of the log entry or null if no properties are specified.

log

public final void log(int severity,
                      java.lang.String message)
Description copied from interface: ILogger
Creates and publishes a log entry with the specified attributes.

Specified by:
log in interface ILogger
Parameters:
severity - The severity of the log entry.
message - The message associated with the log entry or null to not include a message.

log

public final void log(int severity,
                      java.lang.String message,
                      java.util.Dictionary properties)
Description copied from interface: ILogger
Creates and publishes a log entry with the specified attributes.

Specified by:
log in interface ILogger
Parameters:
severity - The severity of the log entry.
message - The message associated with the log entry or null to not include a message.
properties - The properties of the log entry or null if no properties are specified.

log

public final void log(int severity,
                      java.lang.String[] categories,
                      java.lang.String message)
Description copied from interface: ILogger
Creates and publishes a log entry with the specified attributes.

Specified by:
log in interface ILogger
Parameters:
severity - The severity of the log entry.
categories - The categories the log entry pertains to or null if no catagories are related.
message - The message associated with the log entry or null to not include a message.

log

public final void log(int severity,
                      java.lang.String[] categories,
                      java.lang.String message,
                      java.util.Dictionary properties)
Description copied from interface: ILogger
Creates and publishes a log entry with the specified attributes.

Specified by:
log in interface ILogger
Parameters:
severity - The severity of the log entry.
categories - The categories the log entry pertains to or null if no catagories are related.
message - The message associated with the log entry or null to not include a message.
properties - The properties of the log entry or null if no properties are specified.

isErrorEnabled

public final boolean isErrorEnabled()
Description copied from interface: ILogger
Returns true if the error severity level is enabled.

Specified by:
isErrorEnabled in interface ILogger
Returns:
True if the error severity level is enabled.

error

public final void error(java.lang.String message)
Description copied from interface: ILogger
Creates and publishes an error log entry with the specified attributes.

Specified by:
error in interface ILogger
Parameters:
message - The message associated with the log entry or null to not include a message.

error

public final void error(java.lang.String message,
                        java.util.Dictionary properties)
Description copied from interface: ILogger
Creates and publishes an error log entry with the specified attributes.

Specified by:
error in interface ILogger
Parameters:
message - The message associated with the log entry or null to not include a message.
properties - The properties of the log entry or null if no properties are specified.

error

public final void error(java.lang.String[] categories,
                        java.lang.String message)
Description copied from interface: ILogger
Creates and publishes an error log entry with the specified attributes.

Specified by:
error in interface ILogger
Parameters:
categories - The categories the log entry pertains to or null if no catagories are related.
message - The message associated with the log entry or null to not include a message.

error

public final void error(java.lang.String[] categories,
                        java.lang.String message,
                        java.util.Dictionary properties)
Description copied from interface: ILogger
Creates and publishes an error log entry with the specified attributes.

Specified by:
error in interface ILogger
Parameters:
categories - The categories the log entry pertains to or null if no catagories are related.
message - The message associated with the log entry or null to not include a message.
properties - The properties of the log entry or null if no properties are specified.

isWarnEnabled

public final boolean isWarnEnabled()
Description copied from interface: ILogger
Returns true if the warning severity level is enabled.

Specified by:
isWarnEnabled in interface ILogger
Returns:
True if the warning severity level is enabled.

warn

public final void warn(java.lang.String message)
Description copied from interface: ILogger
Creates and publishes a warning log entry with the specified attributes.

Specified by:
warn in interface ILogger
Parameters:
message - The message associated with the log entry or null to not include a message.

warn

public final void warn(java.lang.String message,
                       java.util.Dictionary properties)
Description copied from interface: ILogger
Creates and publishes a warning log entry with the specified attributes.

Specified by:
warn in interface ILogger
Parameters:
message - The message associated with the log entry or null to not include a message.
properties - The properties of the log entry or null if no properties are specified.

warn

public final void warn(java.lang.String[] categories,
                       java.lang.String message)
Description copied from interface: ILogger
Creates and publishes a warning log entry with the specified attributes.

Specified by:
warn in interface ILogger
Parameters:
categories - The categories the log entry pertains to or null if no catagories are related.
message - The message associated with the log entry or null to not include a message.

warn

public final void warn(java.lang.String[] categories,
                       java.lang.String message,
                       java.util.Dictionary properties)
Description copied from interface: ILogger
Creates and publishes a warning log entry with the specified attributes.

Specified by:
warn in interface ILogger
Parameters:
categories - The categories the log entry pertains to or null if no catagories are related.
message - The message associated with the log entry or null to not include a message.
properties - The properties of the log entry or null if no properties are specified.

isInfoEnabled

public final boolean isInfoEnabled()
Description copied from interface: ILogger
Returns true if the informational severity level is enabled.

Specified by:
isInfoEnabled in interface ILogger
Returns:
True if the informational severity level is enabled.

info

public final void info(java.lang.String message)
Description copied from interface: ILogger
Creates and publishes an informational log entry with the specified attributes.

Specified by:
info in interface ILogger
Parameters:
message - The message associated with the log entry or null to not include a message.

info

public final void info(java.lang.String message,
                       java.util.Dictionary properties)
Description copied from interface: ILogger
Creates and publishes an informational log entry with the specified attributes.

Specified by:
info in interface ILogger
Parameters:
message - The message associated with the log entry or null to not include a message.
properties - The properties of the log entry or null if no properties are specified.

info

public final void info(java.lang.String[] categories,
                       java.lang.String message)
Description copied from interface: ILogger
Creates and publishes an informational log entry with the specified attributes.

Specified by:
info in interface ILogger
Parameters:
categories - The categories the log entry pertains to or null if no catagories are related.
message - The message associated with the log entry or null to not include a message.

info

public final void info(java.lang.String[] categories,
                       java.lang.String message,
                       java.util.Dictionary properties)
Description copied from interface: ILogger
Creates and publishes an informational log entry with the specified attributes.

Specified by:
info in interface ILogger
Parameters:
categories - The categories the log entry pertains to or null if no catagories are related.
message - The message associated with the log entry or null to not include a message.
properties - The properties of the log entry or null if no properties are specified.

isDebugEnabled

public final boolean isDebugEnabled()
Description copied from interface: ILogger
Returns true if the debug severity level is enabled.

Specified by:
isDebugEnabled in interface ILogger
Returns:
True if the debug severity level is enabled.

debug

public final void debug(java.lang.String message)
Description copied from interface: ILogger
Creates and publishes a debug log entry with the specified attributes.

Specified by:
debug in interface ILogger
Parameters:
message - The message associated with the log entry or null to not include a message.

debug

public final void debug(java.lang.String message,
                        java.util.Dictionary properties)
Description copied from interface: ILogger
Creates and publishes a debug log entry with the specified attributes.

Specified by:
debug in interface ILogger
Parameters:
message - The message associated with the log entry or null to not include a message.
properties - The properties of the log entry or null if no properties are specified.

debug

public final void debug(java.lang.String[] categories,
                        java.lang.String message)
Description copied from interface: ILogger
Creates and publishes a debug log entry with the specified attributes.

Specified by:
debug in interface ILogger
Parameters:
categories - The categories the log entry pertains to or null if no catagories are related.
message - The message associated with the log entry or null to not include a message.

debug

public final void debug(java.lang.String[] categories,
                        java.lang.String message,
                        java.util.Dictionary properties)
Description copied from interface: ILogger
Creates and publishes a debug log entry with the specified attributes.

Specified by:
debug in interface ILogger
Parameters:
categories - The categories the log entry pertains to or null if no catagories are related.
message - The message associated with the log entry or null to not include a message.
properties - The properties of the log entry or null if no properties are specified.